home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / bkey210.zip / BLUEKEY.DOC < prev    next >
Text File  |  1997-08-01  |  15KB  |  356 lines
  1. BlueKey's Document                                                      Page 1
  2. ──────────────────────────────────────────────────────────────────────────────                   
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                    ┌──────────────────────────────────────┐
  14.                    │ ▄▄▄▄ ▄▄   ▄▄ ▄ ▄▄▄▄   ▄▄ ▄ ▄▄▄▄ ▄▄ ▄ │
  15.                    │ ██▄█ ██   ██ █ ██▄    ██▄▀ ██▄  ██▄█ │
  16.                    │ ██▄█ ██▄█ ██▄█ ██▄▄   ██ █ ██▄▄ ▄▄▄█ │
  17.                    ├──────────────────────────────────────┤
  18.                    │          PGP shell for OLRs          │
  19.                    └──────────────────────────────────────┘
  20.                                  Version 2.10
  21.                        by Yariv Habot of MasTic Products
  22.                     Copyright (c) 1996,1997 by Yariv Habot
  23.  
  24.  
  25. ┌──────────────┐
  26. │   Contents   │
  27. └──────────────┘
  28.  
  29.         Topic:                                                    Page:
  30.         
  31.         Introduction ................................................ 2
  32.         Features .................................................... 2
  33.         Disclaimer .................................................. 2
  34.         Distribution ................................................ 3
  35.         Files list .................................................. 3
  36.         Installation ................................................ 3
  37.           Installing in Blue Wave ................................... 4
  38.           Installing in Termail ..................................... 4
  39.           Installing in GoldED ...................................... 5
  40.         Comments .................................................... 6
  41.         Thanks ...................................................... 6
  42.         More Info ................................................... 7
  43.  
  44. BlueKey's Document                                                      Page 2
  45. ──────────────────────────────────────────────────────────────────────────────                   
  46.  
  47.  
  48. ┌──────────────┐
  49. │ Introduction │
  50. └──────────────┘
  51.  BlueKey is a PGP shell for OLRs (off-line readers). This version supports
  52.  Blue Wave, Termail and GoldED. There is no need to exit your favorite OLR 
  53.  anymore, All the important functions of PGP are available from inside the 
  54.  readers. BlueKey is the perfect link between your editor, speller, PGP and 
  55.  your off-line reader.
  56.  
  57. ┌──────────────┐
  58. │   Features   │
  59. └──────────────┘
  60.  ■  Menu/command-line driven.
  61.  ■  Mouse support
  62.  ■  Supports BlueWave off-line reader, version 2.12 and up, both DOS and
  63.     protected mode versions.
  64.  ■  Supports Termail version 3.00 and up. Supports Termail's external utility
  65.     feauture since version 4.00 and Termail 5.00's MSGINFO.SYS.
  66.  ■  Supports GoldED version 2.50 and up. Was not tested with earlier versions,
  67.     but might work!
  68.  ■  Works with PGP 2.3 and up (Tested on PGP 2.6.2i).
  69.  ■  Encrypts, Decrypts, Signs, Exports keys, Imports Keys, whatever.
  70.  ■  The only PGP shell for Blue Wave which authenticates PGP signed messages.
  71.  ■  Every message is automatically encrypted to your userid.
  72.  ■  Formats decrypted messages, to add quote marks and lines. An internal
  73.     viewer can be used to display the message as it was written by the sender.
  74.  ■  MultiEncryption menu makes picking a userid easy. 
  75.  ■  Groups of userids for fast encryption lists.
  76.  ■  All PGP's output is displayed to the user for inspection.
  77.  ■  Shells to your speller.
  78.  ■  Appends message to an external file, such as a replies file.
  79.  ■  Keeps backup copies before every PGP function.
  80.  ■  Offers retrieval of messages.
  81.  ■  Deletes or keeps backup copies upon exit.
  82.  ■  Shells to DOS.
  83.  
  84. ┌──────────────┐
  85. │  Disclaimer  │
  86. └──────────────┘
  87.  BlueKey is SHAREWARE. This means that a free distribution of this program
  88.  is allowed as long as:
  89.  a. No fee is charged in any way for distribution.
  90.  b. No changes are made to the files in the software package. Sysops are 
  91.     allowed to add an ad line to the file description file (file_id.diz), but
  92.     not allowed to change any other part of the file, or any other file.
  93.  c. Usage beyond 30 days is forbidden unless registration is made to this
  94.     product by directly contacting the author. Read REGISTER.FRM for details.
  95.  
  96.  BlueKey and SignChk were written by Yariv Habot of MasTic Products, 
  97.  copyrights belong to Yariv Habot.
  98.  PGP(tm) is short for Pretty Good(tm) Privacy from Phil's Pretty Good
  99.  Software by Philip Zimmermann, and is protected by copyright.
  100.  The Blue Wave Offline Mail Reader is a product of Cutting Edge Computing, 
  101.  and is protected by copyright.
  102.  TerMail is a product of Strathrory Systems Ltd, and is protected by
  103.  copyright.
  104.  GoldED is a product of Odinn Sorensen, who holds the copyrights.
  105.  
  106. BlueKey's Document                                                      Page 3
  107. ──────────────────────────────────────────────────────────────────────────────                   
  108.  
  109.  No warranty is given. The writer is not responsible for any damage caused by
  110.  direct\indirect use or mis-use of this software.
  111.  
  112. ┌──────────────┐
  113. │ Distribution │
  114. └──────────────┘
  115.  The newest version of BlueKey is always available at these support sites:
  116.  ■  Busy Town BBS (HQ)     +972-3-9652831 (FREQ "BKEY" 97:200/212)
  117.  ■  Malfunction BBS        +972-2-6565065 (FREQ 97:200/464)
  118.  ■  Anesthesia             +972-7-9954490, +972-7-9971505 (FREQ 97:200/215)
  119.  ■  Family House           +972-2-6541081/2/3/4
  120.  ■  Rogi                   +972-3-9343551, +972-3-9041389 (FREQ 97:200/213)
  121.  ■  The Forbidden Knights  +972-9-7460063 (FREQ 97:200/507)
  122.  
  123.  BlueKey, as all of MasTic Products, is also available on the WWW, at
  124.  http://mastic.home.ml.org.
  125.  
  126. ┌──────────────┐
  127. │  Files list  │
  128. └──────────────┘
  129.  BKEY210B.* should include the following:
  130.  
  131.  BLUEKEY.EXE  - The executable file of the software.
  132.  BKSETUP.EXE  - Setup program, what else could it be?
  133.  BLUEKEY.DOC  - The file you're reading...
  134.  HISTORY.DOC  - The history file of BlueKey.
  135.  ADVANCED.DOC - Documentation for advanced features and details.
  136.  SIGCHK12.ZIP - An external utility for checking PGP signatures in BlueWave.
  137.  BLUEKEY.CMD  - PGP commands for BlueKey
  138.  README.1ST   - A document you should have read before reading this document.
  139.  REGISTER.FRM - BlueKey's registration form.
  140.  KNOWN.BUG    - Known bugs in this version.
  141.  FILE_ID.DIZ  - A short description of this package.
  142.  
  143.  BlueKey creates a few more files while working. See "Additional Files" in 
  144.  ADVANCED.DOC.
  145.  
  146. ┌──────────────┐
  147. │ Installation │
  148. └──────────────┘
  149.  Follow these instructions carefully. If you encounter any problems when
  150.  using BlueKey, read this again and check your installation.
  151.  
  152.  ■ Be sure to have all the files from BKEY210.* in your reader's main
  153.    directory, and then run BKSETUP. Change all the options to fit your system. 
  154.    Setting up your own userid is optional. Refer to "Encrypting a message"
  155.    for further details. 
  156.    The editor and speller commands should have @F at the end, to indicate the
  157.    filename. DO NOT use any other token. If you do not put @F at the end
  158.    of the command line, BlueKey will put the message filename at the end of
  159.    the command.
  160.  
  161. BlueKey's Document                                                      Page 4
  162. ──────────────────────────────────────────────────────────────────────────────                   
  163.  
  164.  ■ Installing in Blue Wave 
  165.    ───────────────────────
  166.    Run Blue Wave and enter the setup menu:
  167.    - Change the editor command to "bluekey.exe @F" (Drive and path are usually
  168.      optional). Do not forget to add "@F"!
  169.    - If BlueKey does not run, check to see if you have "Swap on shell to Msg 
  170.      Editor" and "Swap on shell to browser" set to "yes" in Blue Wave's 
  171.      setup. Another attempt to fix it is by increasing the number of FILES in 
  172.      your config.sys.
  173.  
  174.    BlueKey replaces your editor, and works on reply files. This means that in
  175.    order to run BlueKey, you should choose to reply to the message on which
  176.    BlueKey should work.
  177.    BlueKey allows you to easily run your editor by pressing <M> or <ENTER> in 
  178.    BlueKey's main menu. However, if you wish to use a batch file to run your 
  179.    editors, then refer to appendix B, "Editors' Choice".
  180.    Add the switch "/m" before "@F" if you don't like to use the mouse in
  181.    BlueKey's menus.
  182.  
  183.  ■ Installing in Termail
  184.    ─────────────────────
  185.    In Termail v3.00, it is only possible to install BlueKey as an editor, so
  186.    BlueKey runs when editing/replying to a message. To do so, edit TM.CFG and 
  187.    add/change the editor command line:
  188.    
  189.    Editor      BLUEKEY.EXE @FILE
  190.  
  191.    Users of Termail 4.00 and up have various ways to use and install BlueKey.
  192.    One way is by installing it as an editor, as specified above. 
  193.    Another way is by installing BlueKey as an external utility: edit TM.CFG 
  194.    and add this line next to one of the shift keys:
  195.  
  196.    ShiftF1    BKEY  BLUEKEY !MSG !R
  197.    
  198.    If you have free ShiftF# keys, you can assign BlueKey specific functions to
  199.    the different keys in TM.CFG. The following are all the available options,
  200.    install only those you need. The words placed in brackets should NOT appear
  201.    in the file.
  202.  
  203.    ShiftF1    ENCR  BLUEKEY /E !MSG !R     (encrypt)
  204.    ShiftF2    MENC  BLUEKEY /ME !MSG !R    (MultiEncrypt *)
  205.    ShiftF3    DECR  BLUEKEY /D !MSG !R     (decrypt)
  206.    ShiftF4    CSIG  BLUEKEY /S !MSG !R     (clearsign)
  207.    ShiftF5    SIGN  BLUEKEY /I !MSG !R     (sign)
  208.    ShiftF6    ENSN  BLUEKEY /B !MSG !R     (sign and encrypt)
  209.    ShiftF7    EXPT  BLUEKEY /1 !MSG !R     (export key from the message)
  210.    ShiftF8    IMPT  BLUEKEY /2 !MSG !R     (import key to the message)
  211.  
  212.    (*)  Using the /e switch will attempt to read the recipient's userid from
  213.         MSGINFO.SYS. If this fails, BlueKey will run the MultiEncryption menu.
  214.         Refer to "MultiEncryption" in ADVANCED.DOC for more details.
  215.  
  216.    Add the switch "/m" before "!MSG" if you don't like to use the mouse in
  217.    BlueKey's menus.
  218.  
  219. BlueKey's Document                                                      Page 5
  220. ──────────────────────────────────────────────────────────────────────────────                   
  221.  
  222.  ■ Installing in GoldED 
  223.    ────────────────────
  224.    The installation of BlueKey in GoldED includes defining external utilities,
  225.    assigning keys and adding new commands to the EDITSAVE menu.
  226.  
  227.    * Every line added is optional. If you do not need any of BlueKey's
  228.    * functions available, do not put the relevant line in your configuration
  229.    * file. Also, be sure not to collide with previous settings.
  230.    
  231.    Installing BlueKey's menu
  232.    -------------------------
  233.    The shortest way to install BlueKey in GoldED is putting it as an
  234.    external utility. This would mean that every time you need BlueKey, you
  235.    work with a menu and choose the functions you want to use. This means
  236.    you will not be using the real power of GoldED: activating functions by
  237.    pressing a key.
  238.  
  239.    To install BlueKey this way, add these lines to GOLDED.CFG:
  240.    
  241.    EXTERNUTIL 1 -Wipe -Reload -keepctrl BLUEKEY.EXE @FILE
  242.    
  243.    EDITSAVEUTIL 1 "B BlueKey"             
  244.  
  245.    If you already have an external utility under number one, replace "1"
  246.    with an available free number.
  247.  
  248.    Add this line to GOLDKEYS.CFG to run BlueKey by pressing F11:
  249.  
  250.    F11          ExternUtil01    ; BlueKey
  251.  
  252.    That's it.
  253.    
  254.    
  255.    Installing BlueKey's functions
  256.    ------------------------------
  257.    
  258.    Edit GOLDED.CFG and add these lines:
  259.    
  260.    EXTERNOPTIONS -Wipe -Reload -nokeepctrl
  261.  
  262.    EXTERNUTIL 1 BLUEKEY.EXE /e @FILE "@oname" "@dname"  ; encrypt
  263.    EXTERNUTIL 2 BLUEKEY.EXE /me @FILE                   ; MultiEncrypt (*)
  264.    EXTERNUTIL 3 BLUEKEY.EXE /i @FILE                    ; sign
  265.    EXTERNUTIL 4 BLUEKEY.EXE /s @FILE                    ; clearsign
  266.    EXTERNUTIL 5 BLUEKEY.EXE /b @FILE "@oname" "@dname"  ; encrypt & sign
  267.    EXTERNUTIL 6 -noreload BLUEKEY.EXE /2 @FILE "@oname" ; import a key to msg
  268.    EXTERNUTIL 7 BLUEKEY.EXE /d @FILE                    ; decrypt
  269.    EXTERNUTIL 8 -noreload BLUEKEY.EXE /1 @FILE          ; export keys from msg
  270.  
  271.    (*)  Refer to "MultiEncryption" in ADVANCED.DOC for more details.
  272.  
  273.    Naturally, if you have other external utilities as the first eight, give
  274.    BlueKey functions the available numbers.
  275.  
  276.    Add the switch "/m" before "@FILE" if you don't like to use the mouse in
  277.    BlueKey's menus.
  278.  
  279.    If you need the EXTERNOPTIONS command to be different for some reason,
  280.    add all three switches in every line, for example:
  281.  
  282.    EXTERNUTIL 2 -Wipe -Reload -keepctrl BLUEKEY.EXE /i @FILE                    ; sign
  283.  
  284. BlueKey's Document                                                      Page 6
  285. ──────────────────────────────────────────────────────────────────────────────                   
  286.  
  287.    In order to put these functions on the EDITSAVE menu, add these lines:
  288.  
  289.    EDITSAVEUTIL 1 "E Encrypt the msg"
  290.    EDITSAVEUTIL 2 "M MultiEncryption"
  291.    EDITSAVEUTIL 3 "I sIgn the msg"                
  292.    EDITSAVEUTIL 4 "S clearSign the msg"
  293.    EDITSAVEUTIL 5 "B Both Enc & Sign"             
  294.    EDITSAVEUTIL 6 "2 Import a key 2 msg"       
  295.    
  296.    You probably won't need the next couple of functions there, but in case
  297.    you do:
  298.    
  299.    EDITSAVEUTIL 7 "D Decrypt the msg"             
  300.    EDITSAVEUTIL 8 "1 1 Export keys"              
  301.  
  302.    All EDITSAVEUTIL numbers have to match those of the EXTERNUTILs. Read
  303.    GoldED documentation for further details.
  304.  
  305.    To assign keys to BlueKey's functions, edit GOLDKEYS.CFG and add these
  306.    lines:
  307.    
  308.    F11          ExternUtil01    ; encrypt 
  309.    ^F11         ExternUtil02    ; MultiEncrypt 
  310.    #F11         ExternUtil03    ; sign
  311.    ^F12         ExternUtil04    ; clearSign
  312.    #F12         ExternUtil05    ; encrypt & Sign
  313.    #F10         ExternUtil06    ; import a key to msg
  314.    F12          ExternUtil07    ; decrypt
  315.    ^F10         ExternUtil08    ; export keys from msg
  316.  
  317.    That's it.
  318.  
  319. ┌──────────────┐
  320. │   Comments   │
  321. └──────────────┘
  322.  ■ One of Blue Wave's too many options is the option of quoting a message
  323.    in a reply. You might choose not to quote a message when replying to it, 
  324.    but do remember that BlueKey will simply not work in this case...
  325.  
  326.  ■ Comments should be mailed to one of these addresses:
  327.    Yariv Habot, Ultinet's 97:200/200.19, 
  328.    Yariv Habot, Fidonet's 2:403/418.19,   
  329.    mastic@POBoxes.com.
  330.  
  331. ┌──────────────┐
  332. │    Thanks    │
  333. └──────────────┘
  334.  Haim Ziv, Gili Rosenberg, Nicole Rosenberg, Gadi Osnis, Amitai Rottem.
  335.  
  336. BlueKey's Document                                                      Page 7
  337. ──────────────────────────────────────────────────────────────────────────────                   
  338.  
  339. ┌──────────────┐
  340. │  More Info   │
  341. └──────────────┘
  342.  Read ADVANCED.DOC to learn more about BlueKey.
  343.  The topics discussed in ADVANCED.DOC are:
  344.  
  345.  Additional Files 
  346.  "MyName"
  347.  Encryption
  348.  MultiEncryption 
  349.  Decryption 
  350.  Signatures 
  351.  Import/Export of Keys 
  352.  Backup 
  353.  Editors' Choice
  354.  
  355. -=[End of Document]=-
  356.